<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../../print.css" type="text/css" media="print">
<meta content="QuickPiwik,org.piwik.shortcuts.QuickPiwik,getVisits" name="keywords">
<title>org.piwik.shortcuts.QuickPiwik</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'QuickPiwik - Piwik AS3 API';
				var baseRef = '../../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">Piwik ActionScript3 API</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../index-list.html')" href="../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../index.html?org/piwik/shortcuts/QuickPiwik.html&amp;org/piwik/shortcuts/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;QuickPiwik</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a>&nbsp;| <a href="#constantSummary">Constants</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class QuickPiwik"); titleBar_setSubNav(true,true,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">org.piwik.shortcuts</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class QuickPiwik</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">QuickPiwik <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../images/inherit-arrow.gif"> <a href="../Piwik.html">Piwik</a> <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../images/inherit-arrow.gif"> flash.events.EventDispatcher</td>
</tr>
</table>
<p></p>
 The QuickPiwik class contains all possible methods you can use to get the data from the Piwik 
 and enables to load the data from the piwik analitycs. 
 <p></p>
<p>
<span class="classHeaderTableLabel">See also</span>
</p>
<div class="seeAlso">
<a href="../../piwik/PiwikSetup.html" target="">../../piwik/PiwikSetup.html</a>
<br>
<a href="../../piwik/Piwik.html" target="">../../piwik/Piwik.html</a>
</div>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<div class="showHideLinks">
<div class="hideInheritedProperty" id="hideInheritedProperty">
<a onclick="javascript:setInheritedVisible(false,'Property');" href="#propertySummary" class="showHideLink"><img src="../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Public Properties</a>
</div>
<div class="showInheritedProperty" id="showInheritedProperty">
<a onclick="javascript:setInheritedVisible(true,'Property');" href="#propertySummary" class="showHideLink"><img src="../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Public Properties</a>
</div>
</div>
<table id="summaryTableProperty" class="summaryTable hideInheritedProperty" cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="../Piwik.html#format">format</a> : String = "xml"<div class="summaryTableDescription">
  Sets the format of returning data.</div>
</td><td class="summaryTableOwnerCol"><a href="../Piwik.html">Piwik</a></td>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="../Piwik.html#prettyDisplay">prettyDisplay</a> : Boolean = true<div class="summaryTableDescription">
  This variable is used only if returning type is php.</div>
</td><td class="summaryTableOwnerCol"><a href="../Piwik.html">Piwik</a></td>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="../Piwik.html#settup">settup</a> : <a href="../../piwik/PiwikSetup.html">PiwikSetup</a> = null<div class="summaryTableDescription">
  PiwikSetup object.</div>
</td><td class="summaryTableOwnerCol"><a href="../Piwik.html">Piwik</a></td>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="../Piwik.html#showBusyCursor">showBusyCursor</a> : Boolean = true<div class="summaryTableDescription">
  Show or hide busy cursor while loading the data.</div>
</td><td class="summaryTableOwnerCol"><a href="../Piwik.html">Piwik</a></td>
</tr>
</table>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<div class="showHideLinks">
<div class="hideInheritedMethod" id="hideInheritedMethod">
<a onclick="javascript:setInheritedVisible(false,'Method');" href="#methodSummary" class="showHideLink"><img src="../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Public Methods</a>
</div>
<div class="showInheritedMethod" id="showInheritedMethod">
<a onclick="javascript:setInheritedVisible(true,'Method');" href="#methodSummary" class="showHideLink"><img src="../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Public Methods</a>
</div>
</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#QuickPiwik()">QuickPiwik</a>()</div>
<div class="summaryTableDescription">
   Constructor.</div>
</td><td class="summaryTableOwnerCol">QuickPiwik</td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="../Piwik.html#getLastResult()">getLastResult</a>():Object</div>
<div class="summaryTableDescription">
  Returns last loaded result.</div>
</td><td class="summaryTableOwnerCol"><a href="../Piwik.html">Piwik</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="../Piwik.html#getLastUrl()">getLastUrl</a>():String</div>
<div class="summaryTableDescription">
  Returns last called url.</div>
</td><td class="summaryTableOwnerCol"><a href="../Piwik.html">Piwik</a></td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getVisits()">getVisits</a>($date:String = "yesterday", $period:String = "day", $filterLimit:uint = 30):void</div>
<div class="summaryTableDescription">
  Loads the number of visits.</div>
</td><td class="summaryTableOwnerCol">QuickPiwik</td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="../Piwik.html#init()">init</a>($baseURL:String = "http://piwik.org/demo/", $siteID:uint = 1, $authToken:String = "anonymous"):void</div>
<div class="summaryTableDescription">
  Sets the PiwikSetup object.</div>
</td><td class="summaryTableOwnerCol"><a href="../Piwik.html">Piwik</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="../Piwik.html#makeCall()">makeCall</a>($request:<a href="../requests/PiwikRequest.html">PiwikRequest</a>):void</div>
<div class="summaryTableDescription">
  Sends request to Piwik Analytics.</div>
</td><td class="summaryTableOwnerCol"><a href="../Piwik.html">Piwik</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="../Piwik.html#toString()">toString</a>():String</div>
<div class="summaryTableDescription">
  Returns Piwik Object as a String.</div>
</td><td class="summaryTableOwnerCol"><a href="../Piwik.html">Piwik</a></td>
</tr>
</table>
</div>
<a name="constantSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Constants</div>
<div class="showHideLinks">
<div class="hideInheritedConstant" id="hideInheritedConstant">
<a onclick="javascript:setInheritedVisible(false,'Constant');" href="#constantSummary" class="showHideLink"><img src="../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Public Constants</a>
</div>
<div class="showInheritedConstant" id="showInheritedConstant">
<a onclick="javascript:setInheritedVisible(true,'Constant');" href="#constantSummary" class="showHideLink"><img src="../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Public Constants</a>
</div>
</div>
<table id="summaryTableConstant" class="summaryTable hideInheritedConstant" cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Constant</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="hideInheritedConstant">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="../Piwik.html#AGENCY">AGENCY</a> : String = "bluestepstudio.it"<div class="summaryTableDescription">[static]
  Enables agency information to be retrieved at runtime or when reviewing a decompiled swf.</div>
</td><td class="summaryTableOwnerCol"><a href="../Piwik.html">Piwik</a></td>
</tr>
<tr class="hideInheritedConstant">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="../Piwik.html#API_VERSION">API_VERSION</a> : String = "Public Beta 1.0.0"<div class="summaryTableDescription">[static]
  Enables API version to be retrieved at runtime or when reviewing a decompiled swf.</div>
</td><td class="summaryTableOwnerCol"><a href="../Piwik.html">Piwik</a></td>
</tr>
<tr class="hideInheritedConstant">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="../Piwik.html#AUTHOR">AUTHOR</a> : String = "(c) Mirko Bordjoski - http://candymandesign.blogspot.com"<div class="summaryTableDescription">[static]
  Enables copyright information to be retrieved at runtime or when reviewing a decompiled swf.</div>
</td><td class="summaryTableOwnerCol"><a href="../Piwik.html">Piwik</a></td>
</tr>
<tr class="hideInheritedConstant">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="../Piwik.html#CSV">CSV</a> : String = "csv"<div class="summaryTableDescription">[static]
  Download CSV format.</div>
</td><td class="summaryTableOwnerCol"><a href="../Piwik.html">Piwik</a></td>
</tr>
<tr class="hideInheritedConstant">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="../Piwik.html#DATE">DATE</a> : String = "May 2008."<div class="summaryTableDescription">[static]
  Enables version date to be retrieved at runtime or when reviewing a decompiled swf.</div>
</td><td class="summaryTableOwnerCol"><a href="../Piwik.html">Piwik</a></td>
</tr>
<tr class="hideInheritedConstant">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="../Piwik.html#HTML">HTML</a> : String = "html"<div class="summaryTableDescription">[static]
  Returns data as HTML.</div>
</td><td class="summaryTableOwnerCol"><a href="../Piwik.html">Piwik</a></td>
</tr>
<tr class="hideInheritedConstant">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="../Piwik.html#JSON">JSON</a> : String = "json"<div class="summaryTableDescription">[static]
  Returns data as JSON.</div>
</td><td class="summaryTableOwnerCol"><a href="../Piwik.html">Piwik</a></td>
</tr>
<tr class="hideInheritedConstant">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="../Piwik.html#NAME">NAME</a> : String = "--|| PIWIK ||--"<div class="summaryTableDescription">[static]
  Enables engine name to be retrieved at runtime or when reviewing a decompiled swf.</div>
</td><td class="summaryTableOwnerCol"><a href="../Piwik.html">Piwik</a></td>
</tr>
<tr class="hideInheritedConstant">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="../Piwik.html#PHP">PHP</a> : String = "php"<div class="summaryTableDescription">[static]
  Returns data as PHP.</div>
</td><td class="summaryTableOwnerCol"><a href="../Piwik.html">Piwik</a></td>
</tr>
<tr class="hideInheritedConstant">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="../Piwik.html#PIWIK_CORE_TEAM">PIWIK_CORE_TEAM</a> : String = "(c)  Matthieu Aubry - | Julien Rouvi&egrave;re | Johan Math&eacute; | Thierry Scelles"<div class="summaryTableDescription">[static]
  Enables piwik core team information to be retrieved at runtime or when reviewing a decompiled swf.</div>
</td><td class="summaryTableOwnerCol"><a href="../Piwik.html">Piwik</a></td>
</tr>
<tr class="hideInheritedConstant">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="../Piwik.html#RSS">RSS</a> : String = "rss"<div class="summaryTableDescription">[static]
  Returns data as RSS.</div>
</td><td class="summaryTableOwnerCol"><a href="../Piwik.html">Piwik</a></td>
</tr>
<tr class="hideInheritedConstant">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="../Piwik.html#VERSION">VERSION</a> : String = "Public Beta 0.2.2"<div class="summaryTableDescription">[static]
  Enables Piwik version to be retrieved at runtime or when reviewing a decompiled swf.</div>
</td><td class="summaryTableOwnerCol"><a href="../Piwik.html">Piwik</a></td>
</tr>
<tr class="hideInheritedConstant">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="../Piwik.html#XML">XML</a> : String = "xml"<div class="summaryTableDescription">[static]
  Returns data as XML.</div>
</td><td class="summaryTableOwnerCol"><a href="../Piwik.html">Piwik</a></td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="QuickPiwik()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">QuickPiwik</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function QuickPiwik()</code><p>
   Constructor.
   </p></div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="getVisits()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getVisits</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public function getVisits($date:String = "yesterday", $period:String = "day", $filterLimit:uint = 30):void</code><p>
  Loads the number of visits.
  <p />
  
  </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">$date</span>:String</code> (default = "<code>yesterday</code>")<code></code> &mdash;   [optional] You can use magic words like 'last[num_of_days]' eg 'last30', 'yesterday', 'today' or just pass date in format YYYY-MM-DD.
  </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">$period</span>:String</code> (default = "<code>day</code>")<code></code> &mdash;   [optional] Can be 'day', 'week', 'month' or 'year'.
  </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">$filterLimit</span>:uint</code> (default = <code>30</code>)<code></code> &mdash; [optional] Limit the number of rows.
  
  </td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../logic/PiwikFormatter.html" target="">org.piwik.logic.PiwikFormatter</a>
</div>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
